Move common docs upstream #9
Conversation
| stop: 32 | ||
| parallel_mode: null | ||
|
|
||
| - name: dream_3D_env |
There was a problem hiding this comment.
Not sure if Dream3D is a material science specific tool or general enough to be relevant to HPCflow users too?
There was a problem hiding this comment.
I think we'll only want to include the python_env example here.
There was a problem hiding this comment.
Also we need to update: command: python <<script_name>> <<args>> to command: python "<<script_path>>" <<args>>
| stop: 32 | ||
| parallel_mode: null | ||
|
|
||
| - name: dream_3D_env |
There was a problem hiding this comment.
I think we'll only want to include the python_env example here.
There was a problem hiding this comment.
We can't include this file in the shared docs because hpcflow has an additional page that must be linked from here (SDK).
| stop: 32 | ||
| parallel_mode: null | ||
|
|
||
| - name: dream_3D_env |
There was a problem hiding this comment.
Also we need to update: command: python <<script_name>> <<args>> to command: python "<<script_path>>" <<args>>
There was a problem hiding this comment.
I think this file needs to be within a.. jinja:: first_ctx block.
| scheduler_args: | ||
| shebang_args: --login | ||
| options: | ||
| -l: short | ||
|
|
There was a problem hiding this comment.
This needs to be updated as per hpcflow/hpcflow-new#805. So:
| scheduler_args: | |
| shebang_args: --login | |
| options: | |
| -l: short | |
| shell_args: | |
| executable_args: ["--login"] | |
| scheduler_args: | |
| directives: | |
| -l: short |
| options: | ||
| -l: mem512 | ||
|
|
||
| Anything specified under `options` is passed directly to the scheduler as a jobscript command (i.e. isn't processed by {{ app_name }} at all). |
There was a problem hiding this comment.
| Anything specified under `options` is passed directly to the scheduler as a jobscript command (i.e. isn't processed by {{ app_name }} at all). | |
| Anything specified under `directives` is passed directly to the scheduler as a jobscript command (i.e. isn't processed by {{ app_name }} at all). |
| main: | ||
| num_cores: 16 | ||
| scheduler_args: | ||
| options: {} # "Clear" any previous options which have been set. |
There was a problem hiding this comment.
| main: | |
| num_cores: 16 | |
| scheduler_args: | |
| options: {} # "Clear" any previous options which have been set. | |
| main: | |
| num_cores: 16 | |
| scheduler_args: | |
| directives: {} # "Clear" any previous directives which have been set. |
| - my_input_2 | ||
| script: <<script:/full/path/to/generate_input_file.py>> | ||
|
|
||
| An example is given in [advanced_workflow.yaml](advanced_workflow.yaml), along with the alternative code which would be needed |
| Modify the paths to the python scripts under the ``action`` keys to give the full path | ||
| to your files. | ||
|
|
||
| You can then run the workflow using ``{{ app_module }} go workflow.yaml``. |
There was a problem hiding this comment.
| You can then run the workflow using ``{{ app_module }} go workflow.yaml``. | |
| You can then run the workflow using ``{{ app_package_name }} go workflow.yaml``. |
|
|
||
| This is usually caused by updating the {{ app_name }} version. | ||
| Leftover submissions info causes the newer {{ app_name }} version to get confused. | ||
| The fix? ``{{ app_module }} manage clear-known-subs``. |
There was a problem hiding this comment.
| The fix? ``{{ app_module }} manage clear-known-subs``. | |
| The fix? ``{{ app_package_name }} manage clear-known-subs``. |
We have accidentally been improving the MatFlow docs and ignoring the HPCflow ones. Any changes that are also relevant to HPCflow should be in this repo so they are populated to both docs.